docker_api connection plugin: adjust to ansible-core 2.13 #308

felixfontein · 2022-03-18T21:32:25Z

SUMMARY

Similar to #297.

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

docker connection plugin

github-actions · 2022-03-18T21:34:04Z

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run:
https://github.com/ansible-collections/community.docker/actions/runs/2006519013

File changes:

M collections/community/docker/docker_api_connection.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/community.docker/community.docker/docsbuild/base/collections/community/docker/docker_api_connection.html b/home/runner/work/community.docker/community.docker/docsbuild/head/collections/community/docker/docker_api_connection.html
index 5f15e42..ddf058c 100644
--- a/home/runner/work/community.docker/community.docker/docsbuild/base/collections/community/docker/docker_api_connection.html
+++ b/home/runner/work/community.docker/community.docker/docsbuild/head/collections/community/docker/docker_api_connection.html
@@ -225,6 +225,36 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </div></td>
 </tr>
 <tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-container_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-container-timeout"><strong>container_timeout</strong></p>
+<a class="ansibleOptionLink" href="#parameter-container_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>Controls how long we can wait to access reading output from the container once execution started.</p>
+<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">10</span></p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul>
+<li><p>INI entries:</p>
+<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">defaults</span><span class="p p-Indicator">]</span><span class="w"></span>
+<span class="l l-Scalar l-Scalar-Plain">timeout = 10</span><span class="w"></span>
+</pre></div>
+</div>
+<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">docker_connection</span><span class="p p-Indicator">]</span><span class="w"></span>
+<span class="l l-Scalar l-Scalar-Plain">timeout = 10</span><span class="w"></span>
+</pre></div>
+</div>
+<p><span class="ansible-option-versionadded">added in 2.2.0 of community.docker</span></p>
+</li>
+<li><p>Environment variable: ANSIBLE_TIMEOUT</p></li>
+<li><p>Environment variable: ANSIBLE_DOCKER_TIMEOUT</p>
+<p><span class="ansible-option-versionadded">added in 2.2.0 of community.docker</span></p>
+</li>
+<li><p>Variable: ansible_docker_timeout</p>
+<p><span class="ansible-option-versionadded">added in 2.2.0 of community.docker</span></p>
+</li>
+<li><p>CLI argument: –timeout</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-debug"><strong>debug</strong></p>
 <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
 </div></td>
@@ -236,7 +266,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-docker_host"></div>
 <div class="ansibleOptionAnchor" id="parameter-docker_url"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-docker-url"><span id="ansible-collections-community-docker-docker-api-connection-parameter-docker-host"></span><strong>docker_host</strong></p>
 <a class="ansibleOptionLink" href="#parameter-docker_host" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: docker_url</span></p>
@@ -251,7 +281,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-remote-addr"><strong>remote_addr</strong></p>
 <a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
@@ -259,24 +289,34 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“inventory_hostname”</span></p>
 <p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
 <ul class="simple">
+<li><p>Variable: inventory_hostname</p></li>
 <li><p>Variable: ansible_host</p></li>
 <li><p>Variable: ansible_docker_host</p></li>
 </ul>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-remote-user"><strong>remote_user</strong></p>
 <a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
 <td><div class="ansible-option-cell"><p>The user to execute as inside the container.</p>
 <p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
-<ul class="simple">
+<ul>
+<li><p>INI entry:</p>
+<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">defaults</span><span class="p p-Indicator">]</span><span class="w"></span>
+<span class="l l-Scalar l-Scalar-Plain">remote_user = None</span><span class="w"></span>
+</pre></div>
+</div>
+</li>
+<li><p>Environment variable: ANSIBLE_REMOTE_USER</p></li>
 <li><p>Variable: ansible_user</p></li>
 <li><p>Variable: ansible_docker_user</p></li>
+<li><p>Keyword: remote_user</p></li>
+<li><p>CLI argument: –user</p></li>
 </ul>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-ssl_version"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-ssl-version"><strong>ssl_version</strong></p>
 <a class="ansibleOptionLink" href="#parameter-ssl_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
@@ -288,7 +328,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-timeout"><strong>timeout</strong></p>
 <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
 </div></td>
@@ -301,7 +341,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-tls"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-tls"><strong>tls</strong></p>
 <a class="ansibleOptionLink" href="#parameter-tls" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
 </div></td>
@@ -318,7 +358,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-tls_hostname"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-tls-hostname"><strong>tls_hostname</strong></p>
 <a class="ansibleOptionLink" href="#parameter-tls_hostname" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
@@ -331,7 +371,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-use_ssh_client"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-use-ssh-client"><strong>use_ssh_client</strong></p>
 <a class="ansibleOptionLink" href="#parameter-use_ssh_client" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
 <p><span class="ansible-option-versionadded">added in 1.5.0 of community.docker</span></p>
@@ -345,7 +385,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </ul>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
 <div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-api-connection-parameter-tls-verify"><span id="ansible-collections-community-docker-docker-api-connection-parameter-validate-certs"></span><strong>validate_certs</strong></p>
 <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: tls_verify</span></p>

felixfontein · 2022-03-18T21:51:53Z

CC @bcoca

felixfontein · 2022-03-22T06:11:39Z

@briantist thanks for reviewing this!

(cherry picked from commit b353a39)

…315) * Adjust docker_api plugin to ansible-core 2.13. (#308) (cherry picked from commit b353a39) * Remove 2.2.0 additions, adjust changelog URL.

Adjust docker_api plugin to ansible-core 2.13.

2092161

felixfontein mentioned this pull request Mar 18, 2022

New warning about connection plugin #307

Closed

briantist approved these changes Mar 21, 2022

View reviewed changes

felixfontein merged commit b353a39 into ansible-collections:main Mar 22, 2022

felixfontein deleted the fix-docker_api-config branch March 22, 2022 06:11

felixfontein added a commit to felixfontein/community.docker that referenced this pull request Mar 22, 2022

Adjust docker_api plugin to ansible-core 2.13. (ansible-collections#308)

7e612a0

(cherry picked from commit b353a39)

felixfontein mentioned this pull request Mar 22, 2022

[stable-1] docker_api connection plugin: adjust to ansible-core 2.13 #315

Merged

wyoa-bot bot mentioned this pull request Mar 28, 2022

feat(ansible): update dependency community.docker to v2.3.0 jr0dd/home-ops#969

Merged

1 task

renovate bot mentioned this pull request Apr 24, 2022

chore(deps): update community.docker to 2.6.0 - autoclosed xfgjdsytdsg/home-cluster#30

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docker_api connection plugin: adjust to ansible-core 2.13 #308

docker_api connection plugin: adjust to ansible-core 2.13 #308

felixfontein commented Mar 18, 2022

github-actions bot commented Mar 18, 2022

felixfontein commented Mar 18, 2022

felixfontein commented Mar 22, 2022

docker_api connection plugin: adjust to ansible-core 2.13 #308

docker_api connection plugin: adjust to ansible-core 2.13 #308

Conversation

felixfontein commented Mar 18, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

github-actions bot commented Mar 18, 2022

Docs Build 📝

felixfontein commented Mar 18, 2022

felixfontein commented Mar 22, 2022